blob: 570b691ba19322ad33b2cc0d76a37e4ab09b1d1f [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamano341071d2006-06-04 07:24:485the git commands behavior. They can be used by both the git plumbing
Junio C Hamano07824ce2006-04-25 07:36:546and the porcelains. The variables are divided to sections, where
7in the fully qualified variable name the variable itself is the last
8dot-separated segment and the section name is everything before the last
9dot. The variable names are case-insensitive and only alphanumeric
10characters are allowed. Some variables may appear multiple times.
11
12The syntax is fairly flexible and permissive; whitespaces are mostly
13ignored. The '#' and ';' characters begin commends to the end of line,
14blank lines are ignored, lines containing strings enclosed in square
15brackets start sections and all the other lines are recognized
16as setting variables, in the form 'name = value'. If there is no equal
17sign on the line, the entire line is taken as 'name' and the variable
18is recognized as boolean "true". String values may be entirely or partially
19enclosed in double quotes; some variables may require special value format.
20
21Example
22~~~~~~~
23
24# Core variables
25[core]
26; Don't trust file modes
27filemode = false
28
29# Our diff algorithm
30[diff]
31external = "/usr/local/bin/gnu-diff -u"
32renames = true
33
34Variables
35~~~~~~~~~
36
37Note that this list is non-comprehensive and not necessarily complete.
38For command-specific variables, you will find more detailed description
39in the appropriate manual page. You will find description of non-core
40porcelain configuration variables in the respective porcelain documentation.
41
42core.fileMode::
43If false, the executable bit differences between the index and
44the working copy are ignored; useful on broken filesystems like FAT.
45See gitlink:git-update-index[1]. True by default.
46
47core.gitProxy::
48A "proxy command" to execute (as 'command host port') instead
49of establishing direct connection to the remote server when
50using the git protocol for fetching. If the variable value is
51in the "COMMAND for DOMAIN" format, the command is applied only
52on hostnames ending with the specified domain string. This variable
53may be set multiple times and is matched in the given order;
54the first match wins.
55
Junio C Hamano341071d2006-06-04 07:24:4856Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
Junio C Hamano07824ce2006-04-25 07:36:5457(which always applies universally, without the special "for"
58handling).
59
60core.ignoreStat::
61The working copy files are assumed to stay unchanged until you
62mark them otherwise manually - Git will not detect the file changes
63by lstat() calls. This is useful on systems where those are very
64slow, such as Microsoft Windows. See gitlink:git-update-index[1].
65False by default.
66
Junio C Hamano88a3a072006-05-04 08:01:4367core.preferSymlinkRefs::
68Instead of the default "symref" format for HEAD
69and other symbolic reference files, use symbolic links.
70This is sometimes needed to work with old scripts that
71expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:5472
Junio C Hamano341071d2006-06-04 07:24:4873core.logAllRefUpdates::
74If true, `git-update-ref` will append a line to
75"$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time
76of the update. If the file does not exist it will be
77created automatically. This information can be used to
78determine what commit was the tip of a branch "2 days ago".
79This value is false by default (no logging).
80
Junio C Hamano07824ce2006-04-25 07:36:5481core.repositoryFormatVersion::
82Internal variable identifying the repository format and layout
83version.
84
85core.sharedRepository::
86If true, the repository is made shareable between several users
87in a group (making sure all the files and objects are group-writable).
88See gitlink:git-init-db[1]. False by default.
89
90core.warnAmbiguousRefs::
91If true, git will warn you if the ref name you passed it is ambiguous
92and might match multiple refs in the .git/refs/ tree. True by default.
93
Junio C Hamano33db4372006-06-07 19:51:4594alias.*::
95Command aliases for the gitlink:git[1] command wrapper - e.g.
96after defining "alias.last = cat-file commit HEAD", the invocation
97"git last" is equivalent to "git cat-file commit HEAD". To avoid
98confusion, aliases that hide existing git commands are ignored.
99Arguments are split at whitespaces, but single or double
100quote pair can be used to quote them.
101
Junio C Hamano07824ce2006-04-25 07:36:54102apply.whitespace::
103Tells `git-apply` how to handle whitespaces, in the same way
104as the '--whitespace' option. See gitlink:git-apply[1].
105
106diff.renameLimit::
107The number of files to consider when performing the copy/rename
108detection; equivalent to the git diff option '-l'.
109
110format.headers::
111Additional email headers to include in a patch to be submitted
112by mail. See gitlink:git-format-patch[1].
113
114gitcvs.enabled::
115Whether the cvs pserver interface is enabled for this repository.
116See gitlink:git-cvsserver[1].
117
118gitcvs.logfile::
119Path to a log file where the cvs pserver interface well... logs
120various stuff. See gitlink:git-cvsserver[1].
121
122http.sslVerify::
123Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45124over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54125variable.
126
127http.sslCert::
128File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45129over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54130variable.
131
132http.sslKey::
133File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48134over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54135variable.
136
137http.sslCAInfo::
138File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48139fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54140'GIT_SSL_CAINFO' environment variable.
141
142http.sslCAPath::
143Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45144with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54145by the 'GIT_SSL_CAPATH' environment variable.
146
147http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48148How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54149by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
150
151http.lowSpeedLimit, http.lowSpeedTime::
152If the HTTP transfer speed is less than 'http.lowSpeedLimit'
153for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48154Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54155'GIT_HTTP_LOW_SPEED_TIME' environment variables.
156
157i18n.commitEncoding::
158Character encoding the commit messages are stored in; git itself
159does not care per se, but this information is necessary e.g. when
160importing commits from emails or in the gitk graphical history
161browser (and possibly at other places in the future or in other
162porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
163
164merge.summary::
165Whether to include summaries of merged commits in newly created
166merge commit messages. False by default.
167
168pull.octopus::
169The default merge strategy to use when pulling multiple branches
170at once.
171
172pull.twohead::
173The default merge strategy to use when pulling a single branch.
174
175show.difftree::
176The default gitlink:git-diff-tree[1] arguments to be used
177for gitlink:git-show[1].
178
179showbranch.default::
180The default set of branches for gitlink:git-show-branch[1].
181See gitlink:git-show-branch[1].
182
183user.email::
184Your email address to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:48185Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
Junio C Hamano07824ce2006-04-25 07:36:54186environment variables. See gitlink:git-commit-tree[1].
187
188user.name::
189Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:48190Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano07824ce2006-04-25 07:36:54191environment variables. See gitlink:git-commit-tree[1].
192
193whatchanged.difftree::
194The default gitlink:git-diff-tree[1] arguments to be used
195for gitlink:git-whatchanged[1].
196
197imap::
198The configuration variables in the 'imap' section are described
199in gitlink:git-imap-send[1].